chore(atomic): applying documentation text standards to atomic#6850
Merged
tbaxter-coveo merged 2 commits intomainfrom Jan 19, 2026
Merged
chore(atomic): applying documentation text standards to atomic#6850tbaxter-coveo merged 2 commits intomainfrom
tbaxter-coveo merged 2 commits intomainfrom
Conversation
tbaxter-coveo
requested review from
fbeaudoincoveo,
jmazzah-coveo and
louis-bompart
tbaxter-coveo
had a problem deploying
to
PR Artifacts
GitHub Actions
Failure
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
had a problem deploying
to
PR Artifacts
GitHub Actions
Failure
Contributor
There was a problem hiding this comment.
Pull request overview
This PR applies documentation text standards to Atomic components, focusing on improving consistency and clarity in comments and documentation. The changes include standardizing terminology, code formatting, and correcting minor grammatical issues.
Key Changes
- Standardizing "e.g." to "for example" throughout documentation
- Converting italic formatting (underscores) to backticks for code elements and technical terms
- Correcting grammatical issues like "datepicker" to "date picker" and "viewbox" to
viewbox - Adding/removing whitespace for consistency in documentation files
Reviewed changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/atomic/src/components/search/result-template-components/quickview-word-highlight/iframe-parser.ts | Standardized "e.g." to "for example" in comment |
| packages/atomic/src/components/search/atomic-result-section-bottom-metadata/atomic-result-section-bottom-metadata.ts | Fixed curly quote to straight quote in JSDoc |
| packages/atomic/src/components/search/atomic-result-multi-value-text/atomic-result-multi-value-text.ts | Changed italic formatting to backticks for variable name in documentation |
| packages/atomic/src/components/search/atomic-field-condition/atomic-field-condition.ts | Standardized "e.g." to "for example" in property documentation (4 occurrences) |
| packages/atomic/src/components/search/atomic-did-you-mean/atomic-did-you-mean.tsx | New file addition with properly formatted documentation |
| packages/atomic/src/components/search/Introduction.mdx | Whitespace cleanup |
| packages/atomic/src/components/ipx/atomic-ipx-tab/atomic-ipx-tab.tsx | New file addition with properly formatted documentation |
| packages/atomic/src/components/ipx/atomic-ipx-button/atomic-ipx-button.tsx | Added backticks around technical term "viewbox" in comment |
| packages/atomic/src/components/insight/atomic-insight-timeframe-facet/atomic-insight-timeframe-facet.tsx | Corrected "datepicker" to "date picker" and grammar |
| packages/atomic/src/components/insight/atomic-insight-tab/atomic-insight-tab.tsx | New file addition with properly formatted documentation |
| packages/atomic/src/components/common/validate-props-controller/validate-props-controller.ts | Updated hyphenation and @param documentation (has issue) |
| packages/atomic/src/components/common/atomic-modal/atomic-modal.ts | Added backticks around technical term "interfaceElement" |
| packages/atomic/src/components/common/atomic-layout-section/atomic-layout-section.ts | Standardized "E.g." to "For example" |
| packages/atomic/src/components/commerce/product-template-component-utils/context/stencil-product-template-decorators.tsx | Added backticks around technical term "connectedCallback" |
| packages/atomic/src/components/commerce/atomic-product-multi-value-text/atomic-product-multi-value-text.ts | Changed italic formatting to backticks for variable name |
| packages/atomic/src/components/commerce/atomic-commerce-product-list/atomic-commerce-product-list.ts | Added backticks around HTML element names in @part documentation |
| packages/atomic/src/components/commerce/Introduction.mdx | Grammar fix and whitespace cleanup (has issue) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/atomic/src/components/common/validate-props-controller/validate-props-controller.ts
Outdated
Show resolved
Hide resolved
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
had a problem deploying
to
PR Artifacts
GitHub Actions
Failure
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
had a problem deploying
to
PR Artifacts
GitHub Actions
Failure
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
developer-experience-bot
bot
temporarily deployed
to
Prerelease (CDN)
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
Prerelease (CDN)
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
added
the
high-confidence
jsmith2-coveo
approved these changes
Jan 8, 2026
fbeaudoincoveo
approved these changes
Jan 9, 2026
tbaxter-coveo
force-pushed
the
KIT-5291
branch
from
59daf03 to
a81093b
Compare
tbaxter-coveo
had a problem deploying
to
PR Artifacts
GitHub Actions
Failure
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
force-pushed
the
KIT-5291
branch
from
a81093b to
a31bad0
Compare
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
developer-experience-bot
bot
temporarily deployed
to
Prerelease (CDN)
SimonMilord
approved these changes
Jan 19, 2026
tbaxter-coveo
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
In the docs repo all written text must be run through Vale in order to be merged.
When versions of Atomic get released, all of the strings in the atomic components which do not pass linting must be manually fixed.
This PR attempts to address this at the root.
Note
As we will ultimately be moving away from having the component reference generated and hosted on the docs site (instead relying on storybook as the single source of truth), it might be worth looking into sharing the Vale rule set between the Docs repo and UI-Kit to ensure that all documentation has a consistent tone and a common standard.
KIT-5291